<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: aace::carControl::CarControl Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Alexa Auto SDK
   &#160;<span id="projectnumber">2.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>aace</b></li><li class="navelem"><b>carControl</b></li><li class="navelem"><a class="el" href="classaace_1_1car_control_1_1_car_control.html">CarControl</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classaace_1_1car_control_1_1_car_control-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">aace::carControl::CarControl Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a84ce7f162332e09c9e7ff35f240ca1d4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a84ce7f162332e09c9e7ff35f240ca1d4">CarControl</a> ()=default</td></tr>
<tr class="separator:a84ce7f162332e09c9e7ff35f240ca1d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a6f08b35b122c21fef79c0304a77d0a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a2a6f08b35b122c21fef79c0304a77d0a">~CarControl</a> ()</td></tr>
<tr class="separator:a2a6f08b35b122c21fef79c0304a77d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9386e89c038f9d215611f34eaeb7de4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#ae9386e89c038f9d215611f34eaeb7de4">turnPowerControllerOn</a> (const std::string &amp;endpointId)</td></tr>
<tr class="separator:ae9386e89c038f9d215611f34eaeb7de4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a213c71cb12f115e5c826fca82ef62905"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a213c71cb12f115e5c826fca82ef62905">turnPowerControllerOff</a> (const std::string &amp;endpointId)</td></tr>
<tr class="separator:a213c71cb12f115e5c826fca82ef62905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a094718c3c42f12adae6adfb8a4cee2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a9a094718c3c42f12adae6adfb8a4cee2">isPowerControllerOn</a> (const std::string &amp;endpointId, bool &amp;isOn)</td></tr>
<tr class="separator:a9a094718c3c42f12adae6adfb8a4cee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fe461687d626b4530e2d25022851723"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a2fe461687d626b4530e2d25022851723">turnToggleControllerOn</a> (const std::string &amp;endpointId, const std::string &amp;controllerId)</td></tr>
<tr class="separator:a2fe461687d626b4530e2d25022851723"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a817fe2332c70813506adae57188cc63a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a817fe2332c70813506adae57188cc63a">turnToggleControllerOff</a> (const std::string &amp;endpointId, const std::string &amp;controllerId)</td></tr>
<tr class="separator:a817fe2332c70813506adae57188cc63a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a122710f35e288fb86c40564b782ebc7d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a122710f35e288fb86c40564b782ebc7d">isToggleControllerOn</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, bool &amp;isOn)</td></tr>
<tr class="separator:a122710f35e288fb86c40564b782ebc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6eb554713a311dcf2dbe6aca00e1739e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a6eb554713a311dcf2dbe6aca00e1739e">setRangeControllerValue</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, double value)</td></tr>
<tr class="separator:a6eb554713a311dcf2dbe6aca00e1739e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a640312cd115ee0bc8cf86886f6d7ea90"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a640312cd115ee0bc8cf86886f6d7ea90">adjustRangeControllerValue</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, double delta)</td></tr>
<tr class="separator:a640312cd115ee0bc8cf86886f6d7ea90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37f2556dd5b73fe6a098679b9cce60d5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a37f2556dd5b73fe6a098679b9cce60d5">getRangeControllerValue</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, double &amp;value)</td></tr>
<tr class="separator:a37f2556dd5b73fe6a098679b9cce60d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68e0a7b00fa0024f83240e273817390a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#a68e0a7b00fa0024f83240e273817390a">setModeControllerValue</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, const std::string &amp;value)</td></tr>
<tr class="separator:a68e0a7b00fa0024f83240e273817390a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa19e4a06851823ba3b1ff60c73016ee4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#aa19e4a06851823ba3b1ff60c73016ee4">adjustModeControllerValue</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, int delta)</td></tr>
<tr class="separator:aa19e4a06851823ba3b1ff60c73016ee4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4aa2eb8be815b26dc69badac72d0eca"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1car_control_1_1_car_control.html#ab4aa2eb8be815b26dc69badac72d0eca">getModeControllerValue</a> (const std::string &amp;endpointId, const std::string &amp;controllerId, std::string &amp;value)</td></tr>
<tr class="separator:ab4aa2eb8be815b26dc69badac72d0eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classaace_1_1car_control_1_1_car_control.html">CarControl</a> should be extended to interface the elements that can be controlled in the vehicle. Each controllable element is an 'endpoint' with a unique <code>endpointId</code>. <code><a class="el" href="classaace_1_1car_control_1_1_car_control.html">CarControl</a></code> provides interfaces for four types of controllers. A custom combination of these controllers describes controls of the entire vehicle: </p><ul>
<li>Power Controller: Controls the power state of an endpoint. A maximum of one Power Controller is allowed per endpoint, identified by <code>endpointId</code>. </li>
<li>Toggle Controller: Controls the power state of a particular setting of an endpoint. Multiple Toggle Controllers for unique settings are allowed per endpoint, each identified by the combination of <code>endpointId</code> and <code>controllerId</code>. </li>
<li>Range Controller: Controls the settings of an endpoint that can be accessed with a range of values. Multiple Range Controllers for unique settings are allowed per endpoint, each identified by the combination of <code>endpointId</code> and <code>controllerId</code>. </li>
<li>Mode Controller: Controls the settings of an endpoint that can be accessed with a set of modes. Multiple Mode Controllers for unique settings are allowed per endpoint, each identified by the combination of <code>endpointId</code> and <code>controllerId</code>. </li>
</ul>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a84ce7f162332e09c9e7ff35f240ca1d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ce7f162332e09c9e7ff35f240ca1d4">&#9670;&nbsp;</a></span>CarControl()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">aace::carControl::CarControl::CarControl </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classaace_1_1car_control_1_1_car_control.html">CarControl</a> constructor. </p>

</div>
</div>
<a id="a2a6f08b35b122c21fef79c0304a77d0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a6f08b35b122c21fef79c0304a77d0a">&#9670;&nbsp;</a></span>~CarControl()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">aace::carControl::CarControl::~CarControl </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classaace_1_1car_control_1_1_car_control.html">CarControl</a> destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae9386e89c038f9d215611f34eaeb7de4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9386e89c038f9d215611f34eaeb7de4">&#9670;&nbsp;</a></span>turnPowerControllerOn()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::turnPowerControllerOn </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controlId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to power on the controller identified by <code>endpointId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful.</dd></dl>
<p>PowerController </p>

</div>
</div>
<a id="a213c71cb12f115e5c826fca82ef62905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a213c71cb12f115e5c826fca82ef62905">&#9670;&nbsp;</a></span>turnPowerControllerOff()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::turnPowerControllerOff </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to power off the controller identified by <code>endpointId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful. </dd></dl>

</div>
</div>
<a id="a9a094718c3c42f12adae6adfb8a4cee2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a094718c3c42f12adae6adfb8a4cee2">&#9670;&nbsp;</a></span>isPowerControllerOn()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::isPowerControllerOn </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>isOn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves the power state of the controller identified by <code>endpointId</code> from the platform implementation.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">isOn</td><td>To be set to <code>true</code> by the implementation if the controller is powered on. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>isOn</code> was successfully updated, <code>false</code> if the power state of the controller cannot be retrieved. </dd></dl>

</div>
</div>
<a id="a2fe461687d626b4530e2d25022851723"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fe461687d626b4530e2d25022851723">&#9670;&nbsp;</a></span>turnToggleControllerOn()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::turnToggleControllerOn </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controlId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to turn on the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful.</dd></dl>
<p>ToggleController </p>

</div>
</div>
<a id="a817fe2332c70813506adae57188cc63a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a817fe2332c70813506adae57188cc63a">&#9670;&nbsp;</a></span>turnToggleControllerOff()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::turnToggleControllerOff </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to turn off the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful. </dd></dl>

</div>
</div>
<a id="a122710f35e288fb86c40564b782ebc7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a122710f35e288fb86c40564b782ebc7d">&#9670;&nbsp;</a></span>isToggleControllerOn()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::isToggleControllerOn </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>isOn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves the power state of the controller identified by <code>endpointId</code> and <code>controllerId</code> from the platform implementation.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">isOn</td><td>To be set to <code>true</code> by the implementation if the controller is turned on. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>isOn</code> was successfully updated, <code>false</code> if the power state of the controller cannot be retrieved. </dd></dl>

</div>
</div>
<a id="a6eb554713a311dcf2dbe6aca00e1739e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eb554713a311dcf2dbe6aca00e1739e">&#9670;&nbsp;</a></span>setRangeControllerValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::setRangeControllerValue </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controlId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to set the range setting of the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The new range setting. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful.</dd></dl>
<p>RangeController </p>

</div>
</div>
<a id="a640312cd115ee0bc8cf86886f6d7ea90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a640312cd115ee0bc8cf86886f6d7ea90">&#9670;&nbsp;</a></span>adjustRangeControllerValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::adjustRangeControllerValue </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>delta</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to adjust the range setting of the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">delta</td><td>The delta by which to adjust the range setting. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful. </dd></dl>

</div>
</div>
<a id="a37f2556dd5b73fe6a098679b9cce60d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37f2556dd5b73fe6a098679b9cce60d5">&#9670;&nbsp;</a></span>getRangeControllerValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::getRangeControllerValue </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves the range setting of the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>To be set to the current range setting by the implementation. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>value</code> was successfully updated, <code>false</code> if the range setting of the controller cannot be retrieved. </dd></dl>

</div>
</div>
<a id="a68e0a7b00fa0024f83240e273817390a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68e0a7b00fa0024f83240e273817390a">&#9670;&nbsp;</a></span>setModeControllerValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::setModeControllerValue </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controlId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to set the mode of the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The new mode to set. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful.</dd></dl>
<p>ModeController </p>

</div>
</div>
<a id="aa19e4a06851823ba3b1ff60c73016ee4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa19e4a06851823ba3b1ff60c73016ee4">&#9670;&nbsp;</a></span>adjustModeControllerValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::adjustModeControllerValue </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>delta</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation to adjust the mode of the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">delta</td><td>The delta by which to adjust the mode. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful. </dd></dl>

</div>
</div>
<a id="ab4aa2eb8be815b26dc69badac72d0eca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4aa2eb8be815b26dc69badac72d0eca">&#9670;&nbsp;</a></span>getModeControllerValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool aace::carControl::CarControl::getModeControllerValue </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>endpointId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>controllerId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string &amp;&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieves the mode of the controller identified by <code>endpointId</code> and <code>controllerId</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">endpointId</td><td>The unique identifier of the endpoint. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">controllerId</td><td>The unique identifier of the controller. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>To be set to the current mode by the implementation. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>value</code> was successfully updated, <code>false</code> if the mode of the controller cannot be retrieved. </dd></dl>

</div>
</div>
</div><!-- contents -->
<html>
  <body>
    <hr style="height:1px;border-width:0;color:gray;background-color:gray">
    <p style="text-align:left;">
      Alexa Auto SDK 2.2.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
      <span style="float:right;">
        Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
      </span>
    </p>
  </body>
</html>
